docs: automated updates for new_feature#219
Open
jessiemongeon1 wants to merge 2 commits into
Open
Conversation
Automated update based on: New `sui move format` CLI command added as a passthrough to the `prettier-move` auto-formatter
Automated update based on: New `sui move format` CLI command added as a passthrough to the `prettier-move` auto-formatter
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Automated documentation updates triggered by recent release notes.
Changes
Triggered by MystenLabs/move-book#26521: [sui cli] Add pass through command
sui move formatforprettier-movebook/before-we-begin/ide-support.mdbook/guides/code-quality-checklist.mdReview details
book/before-we-begin/ide-support.mdThe documentation page could benefit from an update to mention the new
sui move formatCLI command as an alternative way to use the Move formatter directly through the Sui CLI, without needing to install the separateprettier-movenpm package.Section that needs updating:
## Other (CLI)What is currently there:
The section only mentions the
prettier-plugin-movenpm package as the CLI option for formatting.What should be added:
A mention of the
sui move formatcommand, which provides a built-in way to run theprettier-moveauto-formatter directly through the Sui CLI without needing a separate npm installation.Suggested update:
This is relevant because the new
sui move formatcommand lowers the barrier to entry for code formatting — users who already have the Sui CLI installed don't need to separately install Node.js/npm and the prettier plugin.book/guides/code-quality-checklist.mdThe documentation page already mentions the Move Formatter in the "Code Organization" section at the top, referencing it as an NPM package (
@mysten/prettier-plugin-move), a CI check, and a VSCode plugin. However, it does not mention the newsui move formatCLI command, which is the feature introduced by this PR.Section that needs updating: "Code Organization"
What is currently there:
What should be updated:
The paragraph should mention that the Move Formatter is now also available directly via the
sui move formatCLI command, in addition to the existing NPM/CI/VSCode options. For example:This ensures developers are aware that formatting can now be invoked directly through the Sui CLI without needing to install the NPM package separately.
This PR was automatically generated by the Docs Impact Monitor. Please review the changes carefully before merging.
Each file edit was generated by Claude based on the release notes and a review of the existing documentation content.